<!DOCTYPE html>
<html>
<head>
    <link rel="stylesheet" href="main.css">
    <meta charset="UTF-8">
    <title>ycmd</title>
                                                         </head>
<body>
<div class="container">
    <h1>ycmd</h1>
    <p class="sw-info">
        
        Version: <span class="sw-info-version">0.3.0</span>,     <a href="https://github.com/Valloric/ycmd" class="sw-external-doc">ycmd GitHub page</a>
    
    </p>
    <p><p>ycmd is a code-completion &amp; code-comprehension server.</p>
    <p>ycmd presents a JSON/REST interface to clients over HTTP, validated by HMAC.
    An instance of ycmd is started for each client application.</p>
    <h2 id="general-notes">General Notes</h2>
    <p>The REST interface typically uses HTTP POST requests and expects the payload
    data to be a valid JSON document. The following general principles are
    applied:</p>
    <ul>
    <li>All strings going into and out of the server are UTF-8 encoded.</li>
    <li>All lines end with <code>\n</code>.</li>
    <li>All line and column numbers are 1-based, not 0-based. They are also byte
    offsets, not Unicode codepoint offsets.</li>
    <li>All file paths are full, absolute paths. If a file has not been written
    to disk yet, supply a temporary path.</li>
    <li>All requests to the server must include an HMAC in the x-ycm-hmac HTTP
    header.</li>
    <li>All responses from the server must be validated using the x-ycm-hmac
    header.</li>
    </ul>
    <h2 id="the-example-client">The example client</h2>
    <p>ycmd contains a simple example client in the <code>example</code> directory of the
    source tree. It is written in pure Python with only minimal dependencies.
    It contains trivial implementations of most endpoints and serves to
    supplement this API documentation.</p>
    <p>Consult <code>example/README.md</code> for instructions on getting it running.</p>
    <h2 id="starting-the-server">Starting the server</h2>
    <p>The ycmd server is typically started by a client in order to provide
    services to it. Briefly, starting the server requires supplying some
    configuration and initializing some security features (HMAC).</p>
    <p>The server should be started with a supported version of Python.</p>
    <p>The full list of command line options can be obtained by passing <code>--help</code>
    to ycmd (e.g. <code>python -m ycmd --help</code>). However, the following
    options warrant further discussion:</p>
    <h3 id="-options_file"><code>--options_file</code></h3>
    <p>This mandatory option supplies the name of a file containing user options
    data. This option (and thus the file) are mandatory, as they are required
    to set the shared HMAC secret.</p>
    <p>Once the server has read the options, the server deletes the options file.
    Therefore, the client should typically create a secure temporary file (e.g.
    <code>mkstemp</code>) which contains the options to be used.</p>
    <p>The default options and their values are found in <code>default_settings.json</code>
    within the ycmd codebase.</p>
    <p>The file contains a JSON-formatted object, where the keys are the names of
    options (with any <code>ycm_</code> prefix removed) and the values are the option
    values.</p>
    <p>The canonical list of supported user options can be found in
    YouCompleteMe&#39;s <code>README.md</code>. The option values should have the <code>ycm_</code>
    prefix removed.</p>
    <p>The following additional options are required to be set by the client
    application and should <em>not</em> be visible to the user:</p>
    <ul>
    <li><code>hmac_secret</code>: The shared secret for HMAC authentication. This should be
    16 bytes of random data with as much entropy as possible, encoded as a
    base-64 UTF-8 string. Code for generating this in Python can be found
    in the ycmd example client.</li>
    </ul>
    <h2 id="hmac">HMAC</h2>
    <p>All requests to the server must include an HMAC in the x-ycm-hmac HTTP
    header. The HMAC is computed from the shared secret passed to the server
    on startup and the request/response body. The digest algorithm is SHA-256.
    The server will also include the HMAC in its responses; you must verify it
    before using the response. See the example client to see how it&#39;s done.</p>
    <h2 id="filetypes">Filetypes</h2>
    <p>ycmd uses <code>filetypes</code> to identify the &quot;language&quot; of a given buffer. These
    filetype values are strictly the values understood by Vim. Please see the
    YCM README.md for the list of filetypes recognized by ycmd for semantic
    completion.</p>
    </p>
    
    
    <div id="sw-schemes" class="sw-default-value">
        <span class="sw-default-value-header">Schemes:</span>
        
    </div>
    
        <h2 id="swagger--summary-no-tags">Summary</h2>
        <table class="table table-bordered table-condensed swagger--summary">
            <thead>
            <tr>
                <th>Path</th>
                <th>Operation</th>
                <th>Description</th>
            </tr>
            </thead>
            <tbody>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--completions">/completions</a>
                            </td>
                        <td>
                            <a href="#operation--completions-post">POST</a>
                        </td>
                        <td>
                            <p>Get completion suggestions for the current file context.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--debug_info">/debug_info</a>
                            </td>
                        <td>
                            <a href="#operation--debug_info-post">POST</a>
                        </td>
                        <td>
                            <p>Return server and semantic engine debug information.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--defined_subcommands">/defined_subcommands</a>
                            </td>
                        <td>
                            <a href="#operation--defined_subcommands-post">POST</a>
                        </td>
                        <td>
                            <p>Get the list of subcommands which are available for a completer.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--detailed_diagnostic">/detailed_diagnostic</a>
                            </td>
                        <td>
                            <a href="#operation--detailed_diagnostic-post">POST</a>
                        </td>
                        <td>
                            <p>Get additional information about diagnostic under cursor.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--event_notification">/event_notification</a>
                            </td>
                        <td>
                            <a href="#operation--event_notification-post">POST</a>
                        </td>
                        <td>
                            <p>Notify the server of various client events.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--filter_and_sort_candidates">/filter_and_sort_candidates</a>
                            </td>
                        <td>
                            <a href="#operation--filter_and_sort_candidates-post">POST</a>
                        </td>
                        <td>
                            <p>Filter and sort a set of candidates using ycmd&#39;s fuzzy matching.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--healthy">/healthy</a>
                            </td>
                        <td>
                            <a href="#operation--healthy-get">GET</a>
                        </td>
                        <td>
                            <p>Check if the server is healthy.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--ignore_extra_conf_file">/ignore_extra_conf_file</a>
                            </td>
                        <td>
                            <a href="#operation--ignore_extra_conf_file-post">POST</a>
                        </td>
                        <td>
                            <p>Forcefully ignore the config for the current buffer.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--load_extra_conf_file">/load_extra_conf_file</a>
                            </td>
                        <td>
                            <a href="#operation--load_extra_conf_file-post">POST</a>
                        </td>
                        <td>
                            <p>Forcefully load the config for the current buffer.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--receive_messages">/receive_messages</a>
                            </td>
                        <td>
                            <a href="#operation--receive_messages-post">POST</a>
                        </td>
                        <td>
                            <p>Long poll for asynchronous server messages.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--resolve_completion">/resolve_completion</a>
                            </td>
                        <td>
                            <a href="#operation--resolve_completion-post">POST</a>
                        </td>
                        <td>
                            <p>Resolve detailed_info for a completion item</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--resolve_fixit">/resolve_fixit</a>
                            </td>
                        <td>
                            <a href="#operation--resolve_fixit-post">POST</a>
                        </td>
                        <td>
                            <p>Resolve an incomplete FixIt.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--run_completer_command">/run_completer_command</a>
                            </td>
                        <td>
                            <a href="#operation--run_completer_command-post">POST</a>
                        </td>
                        <td>
                            <p>Run a semantic completer subcommand.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--semantic_completer_available">/semantic_completer_available</a>
                            </td>
                        <td>
                            <a href="#operation--semantic_completer_available-post">POST</a>
                        </td>
                        <td>
                            <p>Determine if semantic completion is available for current buffer.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--signature_help">/signature_help</a>
                            </td>
                        <td>
                            <a href="#operation--signature_help-post">POST</a>
                        </td>
                        <td>
                            <p>Get signature help (argument hints) for current file context.</p>
        
                        </td>
                    </tr>
                    <tr>
                            <td class="swagger--summary-path" rowspan="1">
                                <a href="#path--signature_help_available">/signature_help_available</a>
                            </td>
                        <td>
                            <a href="#operation--signature_help_available-get">GET</a>
                        </td>
                        <td>
                            <p>Is /signature_help supported for some filetype</p>
        
                        </td>
                    </tr>
            </tbody>
        </table>
    
    
    
    <h2>Paths</h2>
    
        
        <span id="path--completions"></span>
            <div id="operation--completions-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Get completion suggestions for the current file context.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/completions</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Returns the autocompletion suggestions for the current cursor
            position. Typically, the server determines whether or not to use
            semantic completion or general (i.e. identifier-based) completion
            based on the language (filetype) and the context. Clients can force
            the use of semantic completion by setting the <code>force_semantic</code>
            property to <code>true</code>.</p>
            <p>Note that if <code>force_semantic</code> is not set to <code>true</code> and the completion
            engine returns an error, the server still tries to fall back to
            general completion, so this endpoint will typically always return
            successfully. Any semantic completer error raised is included in the
            response to be dealt with by the client.</p>
            <p>When <code>force_semantic</code> is <code>true</code>, any error returned by the semantic
            engine is returned via a 500 response.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>The list of completion suggestions.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/CompletionResponse">CompletionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--debug_info"></span>
            <div id="operation--debug_info-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Return server and semantic engine debug information.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/debug_info</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Returns debugging information about the server itself and the
            semantic completer for the current buffer (if there is one).</p>
            <p>This data includes things like the versions of linked-in libraries,
            log file locations, etc.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>A dictionary of debugging information.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                    <div class="col-md-6 sw-response-examples">
                                                        <div class="label label-default">Example for application/json</div>
                                                        <pre>{<br>    "<span class="hljs-attribute">clang</span>": <span class="hljs-value">{<br>        "<span class="hljs-attribute">has_support</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,<br>        "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"clang version"</span><br>    </span>}</span>,<br>    "<span class="hljs-attribute">completer</span>": <span class="hljs-value">{<br>        "<span class="hljs-attribute">items</span>": <span class="hljs-value">[<br>            {<br>                "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"description"</span></span>,<br>                "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">"value"</span><br>            </span>}<br>        ]</span>,<br>        "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"completer name"</span></span>,<br>        "<span class="hljs-attribute">servers</span>": <span class="hljs-value">[<br>            {<br>                "<span class="hljs-attribute">address</span>": <span class="hljs-value"><span class="hljs-string">"127.0.0.1"</span></span>,<br>                "<span class="hljs-attribute">executable</span>": <span class="hljs-value"><span class="hljs-string">"/path/to/executable"</span></span>,<br>                "<span class="hljs-attribute">extras</span>": <span class="hljs-value">[<br>                    {<br>                        "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"description"</span><br>                    </span>},<br>                    {<br>                        "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">"value"</span><br>                    </span>}<br>                ]</span>,<br>                "<span class="hljs-attribute">is_running</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,<br>                "<span class="hljs-attribute">logfiles</span>": <span class="hljs-value">[<br>                    <span class="hljs-string">"/path/to/stdout/logfile"</span>,<br>                    <span class="hljs-string">"/path/to/stderr/logfile"</span><br>                ]</span>,<br>                "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"server name"</span></span>,<br>                "<span class="hljs-attribute">pid</span>": <span class="hljs-value"><span class="hljs-number">12345</span></span>,<br>                "<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">1234</span><br>            </span>}<br>        ]<br>    </span>}</span>,<br>    "<span class="hljs-attribute">extra_conf</span>": <span class="hljs-value">{<br>        "<span class="hljs-attribute">is_loaded</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,<br>        "<span class="hljs-attribute">path</span>": <span class="hljs-value"><span class="hljs-string">"/path/to/extra/conf"</span><br>    </span>}</span>,<br>    "<span class="hljs-attribute">python</span>": <span class="hljs-value">{<br>        "<span class="hljs-attribute">executable</span>": <span class="hljs-value"><span class="hljs-string">"/path/to/python/interpreter"</span></span>,<br>        "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"python version"</span><br>    </span>}<br></span>}</pre>
                                                    </div>
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                            
                                                                    <section class="json-schema-properties">
                                                                        <dl>
                                                                                <dt data-property-name="python">
                                                                                    <span class="json-property-name">python:</span>
                                                                                    
                                                                                    <span class="json-property-type">object</span>
                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                    
                                                                                </dt>
                                                                                <dd>
                                                                                    <p>Debugging information on the Python interpreter in which the
                                                                    server is running.</p>
                                                                    
                                                                                    <div class="json-inner-schema">
                                                                                        
                                                                                                <section class="json-schema-properties">
                                                                                                    <dl>
                                                                                                            <dt data-property-name="executable">
                                                                                                                <span class="json-property-name">executable:</span>
                                                                                                                
                                                                                                                <span class="json-property-type">string</span>
                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                
                                                                                                            </dt>
                                                                                                            <dd>
                                                                                                                <p>Python interpreter path.</p>
                                                                                                
                                                                                                                <div class="json-inner-schema">
                                                                                                                    
                                                                                                                </div>
                                                                                                            </dd>
                                                                                                            <dt data-property-name="version">
                                                                                                                <span class="json-property-name">version:</span>
                                                                                                                
                                                                                                                <span class="json-property-type">string</span>
                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                
                                                                                                            </dt>
                                                                                                            <dd>
                                                                                                                <p>Python interpreter version.</p>
                                                                                                
                                                                                                                <div class="json-inner-schema">
                                                                                                                    
                                                                                                                </div>
                                                                                                            </dd>
                                                                                                    </dl>
                                                                                                </section>
                                                                                    </div>
                                                                                </dd>
                                                                                <dt data-property-name="clang">
                                                                                    <span class="json-property-name">clang:</span>
                                                                                    
                                                                                    <span class="json-property-type">object</span>
                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                    
                                                                                </dt>
                                                                                <dd>
                                                                                    <p>Debugging information on Clang.</p>
                                                                    
                                                                                    <div class="json-inner-schema">
                                                                                        
                                                                                                <section class="json-schema-properties">
                                                                                                    <dl>
                                                                                                            <dt data-property-name="has_support">
                                                                                                                <span class="json-property-name">has_support:</span>
                                                                                                                
                                                                                                                <span class="json-property-type">boolean</span>
                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                
                                                                                                            </dt>
                                                                                                            <dd>
                                                                                                                <p><code>true</code> if the ycmd server was built with Clang support,
                                                                                                <code>false</code> otherwise.</p>
                                                                                                
                                                                                                                <div class="json-inner-schema">
                                                                                                                    
                                                                                                                </div>
                                                                                                            </dd>
                                                                                                            <dt data-property-name="version">
                                                                                                                <span class="json-property-name">version:</span>
                                                                                                                
                                                                                                                <span class="json-property-type">string</span>
                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                
                                                                                                            </dt>
                                                                                                            <dd>
                                                                                                                <p>if <code>has_support</code> is <code>true</code>, return the version of Clang.
                                                                                                Otherwise, return <code>null</code>.</p>
                                                                                                
                                                                                                                <div class="json-inner-schema">
                                                                                                                    
                                                                                                                </div>
                                                                                                            </dd>
                                                                                                    </dl>
                                                                                                </section>
                                                                                    </div>
                                                                                </dd>
                                                                                <dt data-property-name="extra_conf">
                                                                                    <span class="json-property-name">extra_conf:</span>
                                                                                    
                                                                                    <span class="json-property-type">object</span>
                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                    
                                                                                </dt>
                                                                                <dd>
                                                                                    <p>Debugging information on the extra configuration file for the
                                                                    current buffer.</p>
                                                                    
                                                                                    <div class="json-inner-schema">
                                                                                        
                                                                                                <section class="json-schema-properties">
                                                                                                    <dl>
                                                                                                            <dt data-property-name="path">
                                                                                                                <span class="json-property-name">path:</span>
                                                                                                                
                                                                                                                <span class="json-property-type">string</span>
                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                
                                                                                                            </dt>
                                                                                                            <dd>
                                                                                                                <p>Path of the found extra configuration file, loaded or not.</p>
                                                                                                
                                                                                                                <div class="json-inner-schema">
                                                                                                                    
                                                                                                                </div>
                                                                                                            </dd>
                                                                                                            <dt data-property-name="is_loaded">
                                                                                                                <span class="json-property-name">is_loaded:</span>
                                                                                                                
                                                                                                                <span class="json-property-type">boolean</span>
                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                
                                                                                                            </dt>
                                                                                                            <dd>
                                                                                                                <p><code>true</code> if the extra configuration file is loaded, <code>false</code>
                                                                                                otherwise.</p>
                                                                                                
                                                                                                                <div class="json-inner-schema">
                                                                                                                    
                                                                                                                </div>
                                                                                                            </dd>
                                                                                                    </dl>
                                                                                                </section>
                                                                                    </div>
                                                                                </dd>
                                                                                <dt data-property-name="completer">
                                                                                    <span class="json-property-name">completer:</span>
                                                                                    
                                                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/DebugInfoResponse">DebugInfoResponse</a>
                                                                                    </span>
                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                    
                                                                                </dt>
                                                                                <dd>
                                                                                    <p>Contains debugging information on the completer for the given
                                                                    filetypes. <code>null</code> if no completer is available.</p>
                                                                    
                                                                                    <div class="json-inner-schema">
                                                                                        
                                                                                    </div>
                                                                                </dd>
                                                                        </dl>
                                                                    </section>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--defined_subcommands"></span>
            <div id="operation--defined_subcommands-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Get the list of subcommands which are available for a completer.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/defined_subcommands</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Returns the list of completer subcommands for a given completer.</p>
            <p>See also: <code>/run_completer_command</code></p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>The list of available subcommands.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                            
                                                                            <section class="json-schema-array-items">
                                                                                
                                                                                <span class="json-property-type">string</span>
                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                
                                                                                <div class="json-inner-schema">
                                                                                    
                                                                                </div>
                                                                            </section>    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--detailed_diagnostic"></span>
            <div id="operation--detailed_diagnostic-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Get additional information about diagnostic under cursor.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/detailed_diagnostic</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Where available returns addition information about the diagnostic, such
            as the full text of the compile error, suggestions, etc.</p>
            <p>Typically, details are returned for the diagnostic nearest to the
            current cursor position.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>The detailed diagnostic</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                            
                                                                    <section class="json-schema-properties">
                                                                        <dl>
                                                                                <dt data-property-name="message">
                                                                                    <span class="json-property-name">message:</span>
                                                                                    
                                                                                    <span class="json-property-type">string</span>
                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                    
                                                                                        <span class="json-property-required"></span>
                                                                                </dt>
                                                                                <dd>
                                                                                    
                                                                                    <div class="json-inner-schema">
                                                                                        
                                                                                    </div>
                                                                                </dd>
                                                                        </dl>
                                                                    </section>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred, or no diagnostic was available</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--event_notification"></span>
            <div id="operation--event_notification-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Notify the server of various client events.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/event_notification</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>The server needs to react to a number of client events in order to
            provide things like diagnostics and to handle downstream server states
            etc. The client must inform the server of the following events,
            populating the event name in the <code>event_name</code> property:</p>
            <ul>
            <li><code>FileReadyToParse</code>
            Call when a new buffer is opened or after the user has
            stopped typing for some time, or at any other time when the client
            believes that it is worthwhile reparsing the current file and
            updating semantic engines&#39; ASTs and reporting things like updated
            diagnostics.</li>
            <li><code>BufferUnload</code>
            Call when the user closes a buffer that was previously known to be
            open. Closing buffers is important to limit resource usage.</li>
            <li><code>BufferVisit</code> (optional)
            Call when the user focuses on a buffer that is already known.
            <em>Note</em>: The <code>ultisnips_snippets</code> property is optional when firing
            calling this event. Otherwise it is ignored.</li>
            <li><code>InsertLeave</code> (optional)
            For modal editors, call when exiting insert mode. It is equivalent
            to <code>CurrentIdentifierFinished</code>.</li>
            <li><code>CurrentIdentifierFinished</code> (optional)
            Call when the user finishes typing what appears to the client to be
            an identifier.</li>
            <li><code>FileSave</code>
            Call when the user writes to a file on disk. (optional)</li>
            </ul>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The notification data. The line and column are typically not used,
                        but the <code>filepath</code> and file data properties are used to perform
                        semantic analysis (e.g. in the <code>FileReadyToParse</code> handler).</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <section class="json-schema-example">
                                                <pre><code class="lang-json">{<br>    &quot;<span class="hljs-attribute">column_num</span>&quot;: <span class="hljs-value"><span class="hljs-number">20</span></span>,<br>    &quot;<span class="hljs-attribute">event_name</span>&quot;: <span class="hljs-value"><span class="hljs-string">&quot;FileReadyToParse&quot;</span></span>,<br>    &quot;<span class="hljs-attribute">file_data</span>&quot;: <span class="hljs-value">{<br>        &quot;<span class="hljs-attribute">/home/test/dev/test.cc</span>&quot;: <span class="hljs-value">{<br>            &quot;<span class="hljs-attribute">contents</span>&quot;: <span class="hljs-value"><span class="hljs-string">&quot;&lt;file contents&gt;&quot;</span></span>,<br>            &quot;<span class="hljs-attribute">filetypes</span>&quot;: <span class="hljs-value">[<br>                <span class="hljs-string">&quot;cpp&quot;</span><br>            ]<br>        </span>}<br>    </span>}</span>,<br>    &quot;<span class="hljs-attribute">filepath</span>&quot;: <span class="hljs-value"><span class="hljs-string">&quot;/home/test/dev/test.js&quot;</span></span>,<br>    &quot;<span class="hljs-attribute">line_num</span>&quot;: <span class="hljs-value"><span class="hljs-number">10</span><br></span>}
                                        </code></pre>
                                        
                                            </section>
                                        
                                                <section class="json-schema-properties">
                                                    <dl>
                                                            <dt data-property-name="line_num">
                                                                <span class="json-property-name">line_num:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/LineNumber">LineNumber</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="column_num">
                                                                <span class="json-property-name">column_num:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ColumnNumber">ColumnNumber</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="filepath">
                                                                <span class="json-property-name">filepath:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FilePath">FilePath</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="file_data">
                                                                <span class="json-property-name">file_data:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FileDataMap">FileDataMap</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="completer_target">
                                                                <span class="json-property-name">completer_target:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/CompleterTarget">CompleterTarget</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="working_dir">
                                                                <span class="json-property-name">working_dir:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/WorkingDirectory">WorkingDirectory</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="extra_conf_data">
                                                                <span class="json-property-name">extra_conf_data:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ExtraConfData">ExtraConfData</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="event_name">
                                                                <span class="json-property-name">event_name:</span>
                                                                
                                                                <span class="json-property-type">string</span>    <span class="json-property-enum" title="Possible values">, x &isin; {
                                                                                <span class="json-property-enum-item">FileReadyToParse</span>
                                                                            ,
                                                                                <span class="json-property-enum-item">BufferUnload</span>
                                                                            ,
                                                                                <span class="json-property-enum-item">BufferVisit</span>
                                                                            ,
                                                                                <span class="json-property-enum-item">InsertLeave</span>
                                                                            ,
                                                                                <span class="json-property-enum-item">CurrentIdentifierFinished</span>
                                                                            
                                                                        }
                                                                        </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                <p>The event that occurred.</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="ultisnips_snippets">
                                                                <span class="json-property-name">ultisnips_snippets:</span>
                                                                
                                                                <span class="json-property-type">object</span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                <p><em>Optional when <code>event_name</code> is BufferVisit</em>
                                                Supplies the ultisips snippets known for the current
                                                filetypes. Can be used to supply any other type of additional
                                                completion suggestions generated by the client.</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                            <section class="json-schema-properties">
                                                                                <dl>
                                                                                        <dt data-property-name="trigger">
                                                                                            <span class="json-property-name">trigger:</span>
                                                                                            
                                                                                            <span class="json-property-type">string</span>
                                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                                            
                                                                                                <span class="json-property-required"></span>
                                                                                        </dt>
                                                                                        <dd>
                                                                                            <p>The text to insert in order to trigger the snippet. When
                                                                            supplying non-ultisnips suggestions, this is the text
                                                                            to be inserted.</p>
                                                                            
                                                                                            <div class="json-inner-schema">
                                                                                                
                                                                                            </div>
                                                                                        </dd>
                                                                                        <dt data-property-name="description">
                                                                                            <span class="json-property-name">description:</span>
                                                                                            
                                                                                            <span class="json-property-type">string</span>
                                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                                            
                                                                                                <span class="json-property-required"></span>
                                                                                        </dt>
                                                                                        <dd>
                                                                                            <p>Additional text to display in the completion menu, such
                                                                            as a summary of the snippet to be inserted.</p>
                                                                            
                                                                                            <div class="json-inner-schema">
                                                                                                
                                                                                            </div>
                                                                                        </dd>
                                                                                </dl>
                                                                            </section>
                                                                </div>
                                                            </dd>
                                                    </dl>
                                                </section>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>Optional set of diagnostics for the current buffer.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/DiagnosticResponse">DiagnosticResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--filter_and_sort_candidates"></span>
            <div id="operation--filter_and_sort_candidates-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Filter and sort a set of candidates using ycmd&apos;s fuzzy matching.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/filter_and_sort_candidates</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>For filetypes not natively supported by ycmd, clients can often
            determine a set of suitable candidate completion suggestions by other
            means. In Vim this is typically from the <code>omnifunc</code> and other clients
            will have equivalents.</p>
            <p>This endpoint allows clients to use ycmd&#39;s powerful filtering and
            ranking capabilities (including longest-common-subsequence and
            word-boundary-character ranking) on arbitrary sets of identifiers.</p>
            <p><em>NOTE:</em> This API is primarily intended for use when subclassing the
                    <code>Completer</code> class outside of ycmd which is a very niche case,
                    specific to the <code>OmniCompleter</code> in the Vim client. It is not
                    expected that this API be used elsewhere.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The set of candidates to sort of the query parameters.</p>
                        <p><em>NOTE:</em> This <code>request_data</code> object is different from most other
                                ycmd requests as it does not contain buffer data or
                                cursor locations.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                        
                                                <section class="json-schema-properties">
                                                    <dl>
                                                            <dt data-property-name="candidates">
                                                                <span class="json-property-name">candidates:</span>
                                                                
                                                                <span class="json-property-type">object[]</span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                <p>The candidates to filter and sort</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                                    <section class="json-schema-array-items">
                                                                                        
                                                                                        <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Candidate">Candidate</a>
                                                                                        </span>
                                                                                        <span class="json-property-range" title="Value limits"></span>
                                                                                        
                                                                                        <div class="json-inner-schema">
                                                                                            
                                                                                        </div>
                                                                                    </section>                </div>
                                                            </dd>
                                                            <dt data-property-name="sort_property">
                                                                <span class="json-property-name">sort_property:</span>
                                                                
                                                                <span class="json-property-type">string</span>    <span class="json-property-enum" title="Possible values">, x &isin; {
                                                                                <span class="json-property-enum-item">word</span>
                                                                            ,
                                                                                <span class="json-property-enum-item">insertion_text</span>
                                                                            
                                                                        }
                                                                        </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                <p>Typically set to <code>insertion_text</code>, but can be set to <code>word</code> when
                                                the candidates are in the form of a simple list of words. In
                                                the latter case, <code>candidates</code> must be a list of strings.</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="query">
                                                                <span class="json-property-name">query:</span>
                                                                
                                                                <span class="json-property-type">string</span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                <p>The text the user has typed so far for the current identifier.
                                                This is to filter against the suggestions in <code>candidates</code>.</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                    </dl>
                                                </section>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>The filtered list of candidated</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                            
                                                                            <section class="json-schema-array-items">
                                                                                
                                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Candidate">Candidate</a>
                                                                                </span>
                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                
                                                                                <div class="json-inner-schema">
                                                                                    
                                                                                </div>
                                                                            </section>    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--healthy"></span>
            <div id="operation--healthy-get" class="swagger--panel-operation-get panel">
                <div class="panel-heading">
                    <div class="operation-summary">Check if the server is healthy.</div>
                    <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/healthy</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Return <code>true</code> if the server is healthy, <code>false</code> otherwise. The client
            should use this endpoint to keep the server alive.</p>
            
                    </section>
            
                    
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>Server is healthy.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/AlwaysYes">AlwaysYes</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--ignore_extra_conf_file"></span>
            <div id="operation--ignore_extra_conf_file-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Forcefully ignore the config for the current buffer.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/ignore_extra_conf_file</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>As opposed to <code>/load_extra_conf_file</code>, this API endpoint must be called
            when the user declines to load the associated <code>.ycm_extra_conf.py</code> file.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>Configuration file ignored.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/AlwaysYes">AlwaysYes</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred ignoring the configuration file.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--load_extra_conf_file"></span>
            <div id="operation--load_extra_conf_file-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Forcefully load the config for the current buffer.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/load_extra_conf_file</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>By default, ycmd will not load <code>.ycm_extra_conf.py</code> files for security
            reasons and instead raises an exception the first time it requires
            loading.</p>
            <p>In the case that exception is raised, the client should call this
            API endpoint after confirming with the user that it is safe to load
            the reported <code>.ycm_extra_conf.py</code> file.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>Configuration file loaded.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/AlwaysYes">AlwaysYes</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred loading the configuration file.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--receive_messages"></span>
            <div id="operation--receive_messages-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Long poll for asynchronous server messages.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/receive_messages</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Return asynchronous messages from the server. This request is
            used by clients in a &quot;long poll&quot; style, and does not return until
            either:</p>
            <ul>
            <li>A message (or messages) becomes available, in which case a list of
            messages is returned, or</li>
            <li>a timeout occurs (after 60s), in which case <code>true</code> is returned and
            the client should re-send this request, or</li>
            <li>for some reason the server determined that the client should stop
            sending <code>receive_messages</code> requests, in which case <code>false</code> is
            returned, and the client should only send the request again when
            something substantial changes such as a new file type is opened, or
            the completer server is manually restarted.</li>
            </ul>
            <p>The following types of event are delivered asynchronously for certain
            filetypes:</p>
            <ul>
            <li>Status messages to be displayed unobtrusively to the user.</li>
            <li>Diagnostics (for Java only).</li>
            </ul>
            <p>This message is optional. Clients do not require to implement this
            method, but it is strongly recommended for certain languages to offer
            the best user experience.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>Messages are ready, the request timed out, or the request
                                            is not supported and should not be retried.</p>
                                            <p>The response may be <strong>one of</strong> <code>MessagePollResponse</code> or
                                            <code>MessagesList</code>.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                    <div class="col-md-6 sw-response-examples">
                                                        <div class="label label-default">Example for application/json</div>
                                                        <pre>[<br>    {<br>        "<span class="hljs-attribute">message</span>": <span class="hljs-value"><span class="hljs-string">"Initializing: 19% complete"</span><br>    </span>},<br>    {<br>        "<span class="hljs-attribute">message</span>": <span class="hljs-value"><span class="hljs-string">"Initializing: Done."</span><br>    </span>},<br>    {<br>        "<span class="hljs-attribute">diagonostics</span>": <span class="hljs-value">{<br>            "<span class="hljs-attribute">diagnostics</span>": <span class="hljs-value">[<br>                {<br>                    "<span class="hljs-attribute">fixit_available</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,<br>                    "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"WARNING"</span></span>,<br>                    "<span class="hljs-attribute">location</span>": <span class="hljs-value">{<br>                        "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>,<br>                        "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                        "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">10</span><br>                    </span>}</span>,<br>                    "<span class="hljs-attribute">location_extent</span>": <span class="hljs-value">{<br>                        "<span class="hljs-attribute">end</span>": <span class="hljs-value">{<br>                            "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>,<br>                            "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                            "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">10</span><br>                        </span>}</span>,<br>                        "<span class="hljs-attribute">start</span>": <span class="hljs-value">{<br>                            "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>,<br>                            "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                            "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">10</span><br>                        </span>}<br>                    </span>}</span>,<br>                    "<span class="hljs-attribute">ranges</span>": <span class="hljs-value">[<br>                        {<br>                            "<span class="hljs-attribute">end</span>": <span class="hljs-value">{<br>                                "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">20</span></span>,<br>                                "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                                "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">10</span><br>                            </span>}</span>,<br>                            "<span class="hljs-attribute">start</span>": <span class="hljs-value">{<br>                                "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>,<br>                                "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                                "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">10</span><br>                            </span>}<br>                        </span>}<br>                    ]</span>,<br>                    "<span class="hljs-attribute">text</span>": <span class="hljs-value"><span class="hljs-string">"Very naughty code!"</span><br>                </span>},<br>                {<br>                    "<span class="hljs-attribute">fixit_available</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,<br>                    "<span class="hljs-attribute">kind</span>": <span class="hljs-value"><span class="hljs-string">"ERROR"</span></span>,<br>                    "<span class="hljs-attribute">location</span>": <span class="hljs-value">{<br>                        "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>,<br>                        "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                        "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">19</span><br>                    </span>}</span>,<br>                    "<span class="hljs-attribute">location_extent</span>": <span class="hljs-value">{<br>                        "<span class="hljs-attribute">end</span>": <span class="hljs-value">{<br>                            "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>,<br>                            "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                            "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">19</span><br>                        </span>}</span>,<br>                        "<span class="hljs-attribute">start</span>": <span class="hljs-value">{<br>                            "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>,<br>                            "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                            "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">19</span><br>                        </span>}<br>                    </span>}</span>,<br>                    "<span class="hljs-attribute">ranges</span>": <span class="hljs-value">[<br>                        {<br>                            "<span class="hljs-attribute">end</span>": <span class="hljs-value">{<br>                                "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">20</span></span>,<br>                                "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                                "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">19</span><br>                            </span>}</span>,<br>                            "<span class="hljs-attribute">start</span>": <span class="hljs-value">{<br>                                "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">11</span></span>,<br>                                "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span></span>,<br>                                "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">19</span><br>                            </span>}<br>                        </span>}<br>                    ]</span>,<br>                    "<span class="hljs-attribute">text</span>": <span class="hljs-value"><span class="hljs-string">"Very dangerous code!"</span><br>                </span>}<br>            ]</span>,<br>            "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/file"</span><br>        </span>}<br>    </span>}<br>]</pre>
                                                    </div>
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                            
                                                                <section class="json-schema-allOf">
                                                                    <section class="json-schema-allOf-inherited">
                                                                        <ul>
                                                                                    <a class="json-schema-ref" href="#/definitions/MessagePollResponse">MessagePollResponse</a>
                                                                                    <a class="json-schema-ref" href="#/definitions/MessageList">MessageList</a>
                                                                        </ul>
                                                                    </section>
                                                                    <section class="json-schema-allOf-additional">
                                                                    </section>
                                                                </section>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--resolve_completion"></span>
            <div id="operation--resolve_completion-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Resolve detailed_info for a completion item</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/resolve_completion</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Given the <code>resolve</code> ID for a completion item, returns the item with
            additional data filled in.</p>
            <p>Note, the supplied <code>request_data</code> must match exactly the <code>request_data</code>
            for the corresponding completion request, except with the <code>resolve</code> key
            filled in with the <code>resolve</code> ID from the completion item&#39;s <code>extra_data</code>.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                        
                                                <section class="json-schema-properties">
                                                    <dl>
                                                            <dt data-property-name="line_num">
                                                                <span class="json-property-name">line_num:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/LineNumber">LineNumber</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="column_num">
                                                                <span class="json-property-name">column_num:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ColumnNumber">ColumnNumber</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="filepath">
                                                                <span class="json-property-name">filepath:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FilePath">FilePath</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="file_data">
                                                                <span class="json-property-name">file_data:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FileDataMap">FileDataMap</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="completer_target">
                                                                <span class="json-property-name">completer_target:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/CompleterTarget">CompleterTarget</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="working_dir">
                                                                <span class="json-property-name">working_dir:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/WorkingDirectory">WorkingDirectory</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="extra_conf_data">
                                                                <span class="json-property-name">extra_conf_data:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ExtraConfData">ExtraConfData</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="resolve">
                                                                <span class="json-property-name">resolve:</span>
                                                                
                                                                <span class="json-property-type">object</span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                <p>The &#39;resolve&#39; key from the &#39;extra_data&#39; in the completion item
                                                to resolve.</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                    </dl>
                                                </section>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>The list of completion suggestions.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ResolveCompletionResponse">ResolveCompletionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--resolve_fixit"></span>
            <div id="operation--resolve_fixit-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Resolve an incomplete FixIt.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/resolve_fixit</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Resolves an incomplete fixit, indicated by <code>&#39;resolve&#39;</code> fixit property.
            Some completers return incomplete fixits in order to avoid blocking on
            expensive fixit calculations.</p>
            <p>When a client wishes to resolve a fixit, the entire <code>FixIt</code> object
            should be sent in the <code>fixit</code> property.</p>
            <p>If a client tries to resolve an already resolved fixit, the same fixit
            is returned in a SubcommandResponse.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <section class="json-schema-example">
                                                <pre><code class="lang-json">{<br>    &quot;<span class="hljs-attribute">file_data</span>&quot;: <span class="hljs-value">{<br>        &quot;<span class="hljs-attribute">/home/test/dev/test.c</span>&quot;: <span class="hljs-value">{<br>            &quot;<span class="hljs-attribute">contents</span>&quot;: <span class="hljs-value"><span class="hljs-string">&quot;&lt;file contents&gt;&quot;</span></span>,<br>            &quot;<span class="hljs-attribute">filetypes</span>&quot;: <span class="hljs-value">[<br>                <span class="hljs-string">&quot;c&quot;</span><br>            ]<br>        </span>}<br>    </span>}</span>,<br>    &quot;<span class="hljs-attribute">filepath</span>&quot;: <span class="hljs-value"><span class="hljs-string">&quot;/home/test/dev/test.c&quot;</span></span>,<br>    &quot;<span class="hljs-attribute">fixit</span>&quot;: <span class="hljs-value">{<br>        &quot;<span class="hljs-attribute">$ref</span>&quot;: <span class="hljs-value"><span class="hljs-string"><a href="#/definitions/UnresolvedFixIt">&quot;#/definitions/UnresolvedFixIt&quot;</a></span><br>    </span>}<br></span>}
                                        </code></pre>
                                        
                                            </section>
                                        
                                                <section class="json-schema-properties">
                                                    <dl>
                                                            <dt data-property-name="filepath">
                                                                <span class="json-property-name">filepath:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FilePath">FilePath</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="file_data">
                                                                <span class="json-property-name">file_data:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FileDataMap">FileDataMap</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="fixit">
                                                                <span class="json-property-name">fixit:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FixIt">FixIt</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                    </dl>
                                                </section>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p>
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>The fixit has been resolved and a FixIt response is returned.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/SubcommandResponse">SubcommandResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--run_completer_command"></span>
            <div id="operation--run_completer_command-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Run a semantic completer subcommand.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/run_completer_command</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Semantic completers offer additional engine-specific commands, known
            as completer subcommands. This endpoint requests a specific command to
            be executed. Typically the &quot;default&quot; semantic completer for the current
            filetype is used, but it is possible to force the use of a particular
            completer, using the <code>completer_target</code> property.</p>
            <p>The command to execute is passed as a list of arguments, the first of
            which is the command name followed by any command- and
            completer-specific additional arguments. This &quot;command line&quot; is passed
            in the <code>command_arguments</code> property.</p>
            <p>The list of available subcommands for a particular semantic completer
            can be queried using the <code>/defined_subcommands</code> endpoint.</p>
            <p>Subcommands may return one of a number of actions, depending on the
            type of command. The following types of response are returned:</p>
            <ul>
            <li>A <em>simple display message</em> response. This is identified where the
            type of the response is scalar (i.e. boolean, number, string) or the
            type of the response is an object with a <code>message</code> property. These
            messages are typically only a single line and can be displayed in
            a message-box or similarly echoed in a status bar or equivalent.</li>
            <li>A <em>FixIt</em> response. This is identified where the type of the response
            is an object with a property named <code>fixits</code>.</li>
            <li>A <em>detailed information</em> response. This is identified where the type
            of the response is an object with a <code>detailed_info</code> property. These
            messages are typically multiple lines (such as the documentation and
            signature for a method) and are best displayed in a panel or preview
            area (or equivalent).</li>
            <li>A <em>GoTo</em> response. This is identified where the response type cannot
            be determined by any of the above methods. A GoTo response may contain
            either a single location (e.g. for <code>GoToDeclaration</code>), or a list of
            possible locations for the user to chose from (such as in a
            <code>GoToReferences</code> subcommand).</li>
            </ul>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <section class="json-schema-example">
                                                <pre><code class="lang-json">{<br>    &quot;<span class="hljs-attribute">column_num</span>&quot;: <span class="hljs-value"><span class="hljs-number">20</span></span>,<br>    &quot;<span class="hljs-attribute">command_arguments</span>&quot;: <span class="hljs-value">[<br>        <span class="hljs-string">&quot;RefactorRename&quot;</span>,<br>        <span class="hljs-string">&quot;Testing&quot;</span><br>    ]</span>,<br>    &quot;<span class="hljs-attribute">completer_target</span>&quot;: <span class="hljs-value"><span class="hljs-string">&quot;filetype_default&quot;</span></span>,<br>    &quot;<span class="hljs-attribute">file_data</span>&quot;: <span class="hljs-value">{<br>        &quot;<span class="hljs-attribute">/home/test/dev/test.js</span>&quot;: <span class="hljs-value">{<br>            &quot;<span class="hljs-attribute">contents</span>&quot;: <span class="hljs-value"><span class="hljs-string">&quot;&lt;file contents&gt;&quot;</span></span>,<br>            &quot;<span class="hljs-attribute">filetypes</span>&quot;: <span class="hljs-value">[<br>                <span class="hljs-string">&quot;javascript&quot;</span><br>            ]<br>        </span>}<br>    </span>}</span>,<br>    &quot;<span class="hljs-attribute">filepath</span>&quot;: <span class="hljs-value"><span class="hljs-string">&quot;/home/test/dev/test.js&quot;</span></span>,<br>    &quot;<span class="hljs-attribute">line_num</span>&quot;: <span class="hljs-value"><span class="hljs-number">10</span></span>,<br>    &quot;<span class="hljs-attribute">options</span>&quot;: <span class="hljs-value">{<br>        &quot;<span class="hljs-attribute">insert_spaces</span>&quot;: <span class="hljs-value"><span class="hljs-literal">true</span></span>,<br>        &quot;<span class="hljs-attribute">tab_size</span>&quot;: <span class="hljs-value"><span class="hljs-number">4</span><br>    </span>}<br></span>}
                                        </code></pre>
                                        
                                            </section>
                                        
                                                <section class="json-schema-properties">
                                                    <dl>
                                                            <dt data-property-name="line_num">
                                                                <span class="json-property-name">line_num:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/LineNumber">LineNumber</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="column_num">
                                                                <span class="json-property-name">column_num:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ColumnNumber">ColumnNumber</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="filepath">
                                                                <span class="json-property-name">filepath:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FilePath">FilePath</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="file_data">
                                                                <span class="json-property-name">file_data:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FileDataMap">FileDataMap</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="completer_target">
                                                                <span class="json-property-name">completer_target:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/CompleterTarget">CompleterTarget</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="working_dir">
                                                                <span class="json-property-name">working_dir:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/WorkingDirectory">WorkingDirectory</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="extra_conf_data">
                                                                <span class="json-property-name">extra_conf_data:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ExtraConfData">ExtraConfData</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="command_arguments">
                                                                <span class="json-property-name">command_arguments:</span>
                                                                
                                                                <span class="json-property-type">string[]</span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                <p>The command line to execute as a list of arguments. The first
                                                such argument is the subcommand to execute (for example:
                                                <code>GoTo</code>).</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                                    <section class="json-schema-array-items">
                                                                                        
                                                                                        <span class="json-property-type">string</span>
                                                                                        <span class="json-property-range" title="Value limits"></span>
                                                                                        
                                                                                        <div class="json-inner-schema">
                                                                                            
                                                                                        </div>
                                                                                    </section>                </div>
                                                            </dd>
                                                            <dt data-property-name="range">
                                                                <span class="json-property-name">range:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Range">Range</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                <p>The range to which the command is applied (only used by the
                                                <em>Format</em> command).</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="options">
                                                                <span class="json-property-name">options:</span>
                                                                
                                                                <span class="json-property-type">object</span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                <p>A set of editor-related options for the current buffer (only
                                                used by the <em>Format</em> command).</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                            <section class="json-schema-properties">
                                                                                <dl>
                                                                                        <dt data-property-name="tab_size">
                                                                                            <span class="json-property-name">tab_size:</span>
                                                                                            
                                                                                            <span class="json-property-type">integer</span>
                                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                                            
                                                                                                <span class="json-property-required"></span>
                                                                                        </dt>
                                                                                        <dd>
                                                                                            <p>The size of a tabulation in spaces.</p>
                                                                            
                                                                                            <div class="json-inner-schema">
                                                                                                
                                                                                            </div>
                                                                                        </dd>
                                                                                        <dt data-property-name="insert_spaces">
                                                                                            <span class="json-property-name">insert_spaces:</span>
                                                                                            
                                                                                            <span class="json-property-type">boolean</span>
                                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                                            
                                                                                                <span class="json-property-required"></span>
                                                                                        </dt>
                                                                                        <dd>
                                                                                            <p>Use spaces to represent tabulations.</p>
                                                                            
                                                                                            <div class="json-inner-schema">
                                                                                                
                                                                                            </div>
                                                                                        </dd>
                                                                                </dl>
                                                                            </section>
                                                                </div>
                                                            </dd>
                                                    </dl>
                                                </section>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>Optional action or display text in response to the request.</p>
                                            <p><em>NOTE</em>: If the type of the response is not an object or list,
                                                    then the response is a <em>simple display message</em>.</p>
                                            <p><em>NOTE</em>: If the type of the response is a list, then the response is
                                                    a GoTo list (e.g. quick-fix list or equivalent) and the
                                                    items in the list are of type <code>GoToLocations</code>
                                                    (see definitions).</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/SubcommandResponse">SubcommandResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--semantic_completer_available"></span>
            <div id="operation--semantic_completer_available-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Determine if semantic completion is available for current buffer.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/semantic_completer_available</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                            <a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>Whether or not semantic completion is available.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/YesNo">YesNo</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--signature_help"></span>
            <div id="operation--signature_help-post" class="swagger--panel-operation-post panel">
                <div class="panel-heading">
                    <div class="operation-summary">Get signature help (argument hints) for current file context.</div>
                    <h3 class="panel-title"><span class="operation-name">POST</span> <strong>/signature_help</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Returns a list of method signatures relevant to the current cursor
            position, along with an indication of which signature and argument
            are &#39;active&#39;.</p>
            <p>Only returned by semantic engines.</p>
            <p>Signatures are actually queried immediately after a trigger character.
            The result of this is that the client and server collude on remembering
            the current &quot;trigger&quot; state for signature help. This trades off
            some complexity in clients for significant performance benefits in the
            general case.</p>
            <p>The client is responsible for maintaining the state of any displayed
            signature help popup, and is responsible for hiding it when this request
            returns an empty set of signatures.</p>
            <p>That is, when this request returns a non-empty list of signatures,
            signature help is considered &quot;triggered&#39; and the client must record this
            and return it in the &#39;signature_help_state&#39; request field
            (value <code>ACTIVE</code>). The client continues to request signature help on
            new input and should update its state to <code>INACTIVE</code> whenever this
            request returns an empty list of signatures.</p>
            <p>If any errors are reported by the semantic engine, they are reported in
            the <code>errors</code> key in the response.</p>
            <p>The first signature and the first argument are both 0.</p>
            
                    </section>
            
                        
                            <section class="sw-request-body">
                                
                                        <div class="row">
                                            <div class="col-md-6">
                                                <p><p>The context data, including the current cursor position, and details
                        of dirty buffers.</p>
                        </p>
                                            </div>
                                            <div class="col-md-6 sw-request-model">
                            <div  class="panel panel-definition">
                                <div class="panel-body">
                                        
                                                <section class="json-schema-properties">
                                                    <dl>
                                                            <dt data-property-name="line_num">
                                                                <span class="json-property-name">line_num:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/LineNumber">LineNumber</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="column_num">
                                                                <span class="json-property-name">column_num:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ColumnNumber">ColumnNumber</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="filepath">
                                                                <span class="json-property-name">filepath:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FilePath">FilePath</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="file_data">
                                                                <span class="json-property-name">file_data:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FileDataMap">FileDataMap</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                                    <span class="json-property-required"></span>
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="completer_target">
                                                                <span class="json-property-name">completer_target:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/CompleterTarget">CompleterTarget</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="extra_conf_data">
                                                                <span class="json-property-name">extra_conf_data:</span>
                                                                
                                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ExtraConfData">ExtraConfData</a>
                                                                </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                            <dt data-property-name="signature_help_state">
                                                                <span class="json-property-name">signature_help_state:</span>
                                                                
                                                                <span class="json-property-type">string</span>    <span class="json-property-enum" title="Possible values">, x &isin; {
                                                                                <span class="json-property-enum-item">ACTIVE</span>
                                                                            ,
                                                                                <span class="json-property-enum-item">INACTIVE</span>
                                                                            
                                                                        }
                                                                        </span>
                                                                <span class="json-property-range" title="Value limits"></span>
                                                                
                                                            </dt>
                                                            <dd>
                                                                <p>The current state of the signature help triggering. After
                                                signatures are returned for the first time (triggered), the
                                                client sends further requests with <code>signature_help_state</code> set
                                                to <code>ACTIVE</code> until the request returns no signatures.</p>
                                                
                                                                <div class="json-inner-schema">
                                                                    
                                                                </div>
                                                            </dd>
                                                    </dl>
                                                </section>
                                </div>
                            </div></div>
                                        </div>
                            </section>        
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>Signature info.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                            
                                                                    <section class="json-schema-properties">
                                                                        <dl>
                                                                                <dt data-property-name="errors">
                                                                                    <span class="json-property-name">errors:</span>
                                                                                    
                                                                                    <span class="json-property-type">object[]</span>
                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                    
                                                                                        <span class="json-property-required"></span>
                                                                                </dt>
                                                                                <dd>
                                                                                    <p>errors reported by the semantic completion engine.</p>
                                                                    
                                                                                    <div class="json-inner-schema">
                                                                                        
                                                                                                        <section class="json-schema-array-items">
                                                                                                            
                                                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                                                                            </span>
                                                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                                                            
                                                                                                            <div class="json-inner-schema">
                                                                                                                
                                                                                                            </div>
                                                                                                        </section>                </div>
                                                                                </dd>
                                                                                <dt data-property-name="signature_help">
                                                                                    <span class="json-property-name">signature_help:</span>
                                                                                    
                                                                                    <span class="json-property-type">object</span>
                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                    
                                                                                        <span class="json-property-required"></span>
                                                                                </dt>
                                                                                <dd>
                                                                                    
                                                                                    <div class="json-inner-schema">
                                                                                        
                                                                                                <section class="json-schema-properties">
                                                                                                    <dl>
                                                                                                            <dt data-property-name="activeSignature">
                                                                                                                <span class="json-property-name">activeSignature:</span>
                                                                                                                
                                                                                                                <span class="json-property-type">number</span>
                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                
                                                                                                                    <span class="json-property-required"></span>
                                                                                                            </dt>
                                                                                                            <dd>
                                                                                                                <p>The active signature. The first is 0.</p>
                                                                                                
                                                                                                                <div class="json-inner-schema">
                                                                                                                    
                                                                                                                </div>
                                                                                                            </dd>
                                                                                                            <dt data-property-name="activeParameter">
                                                                                                                <span class="json-property-name">activeParameter:</span>
                                                                                                                
                                                                                                                <span class="json-property-type">number</span>
                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                
                                                                                                                    <span class="json-property-required"></span>
                                                                                                            </dt>
                                                                                                            <dd>
                                                                                                                <p>The active parameter. The first is 0.</p>
                                                                                                
                                                                                                                <div class="json-inner-schema">
                                                                                                                    
                                                                                                                </div>
                                                                                                            </dd>
                                                                                                            <dt data-property-name="signatures">
                                                                                                                <span class="json-property-name">signatures:</span>
                                                                                                                
                                                                                                                <span class="json-property-type">object[]</span>
                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                
                                                                                                                    <span class="json-property-required"></span>
                                                                                                            </dt>
                                                                                                            <dd>
                                                                                                                <p>The list of signatures</p>
                                                                                                
                                                                                                                <div class="json-inner-schema">
                                                                                                                    
                                                                                                                                    <section class="json-schema-array-items">
                                                                                                                                        
                                                                                                                                        <span class="json-property-type">object</span>
                                                                                                                                        <span class="json-property-range" title="Value limits"></span>
                                                                                                                                        
                                                                                                                                        <div class="json-inner-schema">
                                                                                                                                            
                                                                                                                                                    <section class="json-schema-properties">
                                                                                                                                                        <dl>
                                                                                                                                                                <dt data-property-name="label">
                                                                                                                                                                    <span class="json-property-name">label:</span>
                                                                                                                                                                    
                                                                                                                                                                    <span class="json-property-type">string</span>
                                                                                                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                                                                                                    
                                                                                                                                                                        <span class="json-property-required"></span>
                                                                                                                                                                </dt>
                                                                                                                                                                <dd>
                                                                                                                                                                    <p>The full signature text, including parameters</p>
                                                                                                                                                    
                                                                                                                                                                    <div class="json-inner-schema">
                                                                                                                                                                        
                                                                                                                                                                    </div>
                                                                                                                                                                </dd>
                                                                                                                                                                <dt data-property-name="documentation">
                                                                                                                                                                    <span class="json-property-name">documentation:</span>
                                                                                                                                                                    
                                                                                                                                                                    <span class="json-property-type">string</span>
                                                                                                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                                                                                                    
                                                                                                                                                                </dt>
                                                                                                                                                                <dd>
                                                                                                                                                                    <p>Human readable docstring of the signature.</p>
                                                                                                                                                    
                                                                                                                                                                    <div class="json-inner-schema">
                                                                                                                                                                        
                                                                                                                                                                    </div>
                                                                                                                                                                </dd>
                                                                                                                                                                <dt data-property-name="parameters">
                                                                                                                                                                    <span class="json-property-name">parameters:</span>
                                                                                                                                                                    
                                                                                                                                                                    <span class="json-property-type">object[]</span>
                                                                                                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                                                                                                    
                                                                                                                                                                        <span class="json-property-required"></span>
                                                                                                                                                                </dt>
                                                                                                                                                                <dd>
                                                                                                                                                                    <p>List of parameters</p>
                                                                                                                                                    
                                                                                                                                                                    <div class="json-inner-schema">
                                                                                                                                                                        
                                                                                                                                                                                        <section class="json-schema-array-items">
                                                                                                                                                                                            
                                                                                                                                                                                            <span class="json-property-type">object</span>
                                                                                                                                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                                                                                                                                            
                                                                                                                                                                                            <div class="json-inner-schema">
                                                                                                                                                                                                
                                                                                                                                                                                                        <section class="json-schema-properties">
                                                                                                                                                                                                            <dl>
                                                                                                                                                                                                                    <dt data-property-name="documentation">
                                                                                                                                                                                                                        <span class="json-property-name">documentation:</span>
                                                                                                                                                                                                                        
                                                                                                                                                                                                                        <span class="json-property-type">string</span>
                                                                                                                                                                                                                        <span class="json-property-range" title="Value limits"></span>
                                                                                                                                                                                                                        
                                                                                                                                                                                                                    </dt>
                                                                                                                                                                                                                    <dd>
                                                                                                                                                                                                                        <p>Human readable docstring of the parameter.</p>
                                                                                                                                                                                                        
                                                                                                                                                                                                                        <div class="json-inner-schema">
                                                                                                                                                                                                                            
                                                                                                                                                                                                                        </div>
                                                                                                                                                                                                                    </dd>
                                                                                                                                                                                                                    <dt data-property-name="label">
                                                                                                                                                                                                                        <span class="json-property-name">label:</span>
                                                                                                                                                                                                                        
                                                                                                                                                                                                                        <span class="json-property-type">integer[]</span>
                                                                                                                                                                                                                        <span class="json-property-range" title="Value limits"></span>
                                                                                                                                                                                                                        
                                                                                                                                                                                                                    </dt>
                                                                                                                                                                                                                    <dd>
                                                                                                                                                                                                                        <p>The array of offsets representing an inclusive
                                                                                                                                                                                                        start and exclusive end within the parameter&#39;s
                                                                                                                                                                                                        containing signature label.</p>
                                                                                                                                                                                                        <p>Offsets are byte offsets into the UTF8 encoded
                                                                                                                                                                                                        string &#39;label&#39;</p>
                                                                                                                                                                                                        
                                                                                                                                                                                                                        <div class="json-inner-schema">
                                                                                                                                                                                                                            
                                                                                                                                                                                                                                            <section class="json-schema-array-items">
                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                <span class="json-property-type">integer</span>
                                                                                                                                                                                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                <div class="json-inner-schema">
                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                </div>
                                                                                                                                                                                                                                            </section>                </div>
                                                                                                                                                                                                                    </dd>
                                                                                                                                                                                                            </dl>
                                                                                                                                                                                                        </section>
                                                                                                                                                                                            </div>
                                                                                                                                                                                        </section>                </div>
                                                                                                                                                                </dd>
                                                                                                                                                        </dl>
                                                                                                                                                    </section>
                                                                                                                                        </div>
                                                                                                                                    </section>                </div>
                                                                                                            </dd>
                                                                                                    </dl>
                                                                                                </section>
                                                                                    </div>
                                                                                </dd>
                                                                        </dl>
                                                                    </section>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
        
        <span id="path--signature_help_available"></span>
            <div id="operation--signature_help_available-get" class="swagger--panel-operation-get panel">
                <div class="panel-heading">
                    <div class="operation-summary">Is /signature_help supported for some filetype</div>
                    <h3 class="panel-title"><span class="operation-name">GET</span> <strong>/signature_help_available</strong></h3>
                </div>
                <div class="panel-body">
                    <section class="sw-operation-description">
                        <p>Since /signature_help can be expensive, clients can query ycmd with
            /signature_help_available and then stop sending /signature_help if there
            is no support for that filetype.</p>
            <p>If the response is PENDING, the client should make another
            /signature_help_available request later.</p>
            
                    </section>
            
                    
                        <section class="sw-request-params">
                            <table class="table">
                                <thead>
                                <tr>
                                    <th class="sw-param-name"></th>
                                    <th class="sw-param-description"></th>
                                    <th class="sw-param-type"></th>
                                    <th class="sw-param-data-type"></th>
                                    <th class="sw-param-annotation"></th>
                                </tr>
                                </thead>
                                <tbody>
                                        <tr>
                                            <td>
                                                subserver
                                            </td>
                                            <td><p>Subserver filetype for which the request is made. If a subserver
                                        supports multiple filetypes, the parameter may hold any one of them.</p>
                                        </td>
                                            <td>query</td>
                                            <td>
                                        <span class="json-property-type">string</span>
                                        <span class="json-property-range" title="Value limits"></span>
                                        
                                            </td>
                                            <td>
                                                    <span class="json-property-required"></span>
                                            </td>
                                        </tr>
                                </tbody>
                            </table>
                        </section>
                    
                        <section class="sw-responses">
                                <p><span class="label label-default">application/json</span> 
                    </p>
                    
                            <dl>
                                    <dt class="sw-response-200">
                                        200 OK
                                    
                                    </dt>
                                    <dd class="sw-response-200">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>Signature help support info.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                            
                                                                    <section class="json-schema-properties">
                                                                        <dl>
                                                                                <dt data-property-name="available">
                                                                                    <span class="json-property-name">available:</span>
                                                                                    
                                                                                    <span class="json-property-type">string</span>    <span class="json-property-enum" title="Possible values">, x &isin; {
                                                                                                    <span class="json-property-enum-item">YES</span>
                                                                                                ,
                                                                                                    <span class="json-property-enum-item">NO</span>
                                                                                                ,
                                                                                                    <span class="json-property-enum-item">PENDING</span>
                                                                                                
                                                                                            }
                                                                                            </span>
                                                                                    <span class="json-property-range" title="Value limits"></span>
                                                                                    
                                                                                        <span class="json-property-required"></span>
                                                                                </dt>
                                                                                <dd>
                                                                                    
                                                                                    <div class="json-inner-schema">
                                                                                        
                                                                                    </div>
                                                                                </dd>
                                                                        </dl>
                                                                    </section>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                                    <dt class="sw-response-500">
                                        500 Internal Server Error
                                    
                                    </dt>
                                    <dd class="sw-response-500">
                                            <div class="row">
                                                <div class="col-md-12">
                                                    <p>An error occurred.</p>
                                            
                                                </div>
                                            </div>
                                            <div class="row">
                                                
                                                <div class="col-md-6 sw-response-model">
                                                <div  class="panel panel-definition">
                                                    <div class="panel-body">
                                                                <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                    </div>
                                                </div></div>
                                            
                                            </div>                </dd>
                            </dl>
                        </section>
                </div>
            </div>
    
     
    
                       
        <h2>Schema definitions</h2>
    
            
                <div id="definition-AlwaysYes" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/AlwaysYes"></a>AlwaysYes:
                                    <span class="json-property-type">
                <span class="json-property-type">boolean</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p><code>true</code> is always returned, unless there is an error.</p>
                            
                                </section>
                            
                    </div>
                </div>        
                <div id="definition-Candidate" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/Candidate"></a>Candidate:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="insertion_text">
                                                    <span class="json-property-name">insertion_text:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>The word to insert when selecting the completion.</p>
                                    <p>Equivalent of the Vim <code>complete-items</code> entry: <code>word</code>.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="menu_text">
                                                    <span class="json-property-name">menu_text:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>The word to display as the suggestion to the user. If not
                                    supplied, <code>insertion_text</code> is displayed to the user.</p>
                                    <p>Equivalent of the Vim <code>complete-items</code> entry: <code>abbr</code>.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="extra_menu_info">
                                                    <span class="json-property-name">extra_menu_info:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>Additional information to display about the suggestion within
                                    the completion menu (or equivalent). Typically this is the
                                    signature/declaration of the item being suggested, or some
                                    additional free-text qualifiers (such as <code>[File]</code> etc.). These
                                    are a single line and typically short. For more detailed
                                    information, such as usage and docs, see <code>detailed_info</code>.</p>
                                    <p>Equivalent of the Vim <code>complete-items</code> entry: <code>menu</code>.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="detailed_info">
                                                    <span class="json-property-name">detailed_info:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>Additional information, such as the full signature and method
                                    documentation, suitable for display in a preview window or
                                    tooltip.</p>
                                    <p>Equivalent of the Vim <code>complete-items</code> entry: <code>info</code>.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="kind">
                                                    <span class="json-property-name">kind:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>An indicator of the type of suggestion. Only the first character
                                    of <code>kind</code> should be displayed.</p>
                                    <p>Equivalent of the Vim <code>complete-items</code> entry: <code>kind</code>.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="extra_data">
                                                    <span class="json-property-name">extra_data:</span>
                                                    
                                                    <span class="json-property-type">object</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>Completer-specific additional information.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                <section class="json-schema-properties">
                                                                    <dl>
                                                                            <dt data-property-name="doc_string">
                                                                                <span class="json-property-name">doc_string:</span>
                                                                                
                                                                                <span class="json-property-type">string</span>
                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                
                                                                            </dt>
                                                                            <dd>
                                                                                <p>Additional documentation/information to be displayed
                                                                alongside (after) information in <code>detailed_info</code>.</p>
                                                                
                                                                                <div class="json-inner-schema">
                                                                                    
                                                                                </div>
                                                                            </dd>
                                                                            <dt data-property-name="fixits">
                                                                                <span class="json-property-name">fixits:</span>
                                                                                
                                                                                <span class="json-property-type">object[]</span>
                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                
                                                                            </dt>
                                                                            <dd>
                                                                                <p>Any editional edits to apply when selecting this completion</p>
                                                                
                                                                                <div class="json-inner-schema">
                                                                                    
                                                                                                    <section class="json-schema-array-items">
                                                                                                        
                                                                                                        <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FixIt">FixIt</a>
                                                                                                        </span>
                                                                                                        <span class="json-property-range" title="Value limits"></span>
                                                                                                        
                                                                                                        <div class="json-inner-schema">
                                                                                                            
                                                                                                        </div>
                                                                                                    </section>                </div>
                                                                            </dd>
                                                                            <dt data-property-name="resolve">
                                                                                <span class="json-property-name">resolve:</span>
                                                                                
                                                                                <span class="json-property-type">number</span>
                                                                                <span class="json-property-range" title="Value limits"></span>
                                                                                
                                                                            </dt>
                                                                            <dd>
                                                                                <p>Identifier used to resolve this completion item using
                                                                /resolve_completion. If not supplied, the item is already
                                                                fully resolved.</p>
                                                                
                                                                                <div class="json-inner-schema">
                                                                                    
                                                                                </div>
                                                                            </dd>
                                                                    </dl>
                                                                </section>
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-ColumnNumber" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/ColumnNumber"></a>ColumnNumber:
                                    <span class="json-property-type">
                <span class="json-property-type">integer</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>1-based column byte offset within the line.</p>
                            
                                </section>
                            
                    </div>
                </div>        
                <div id="definition-CompleterTarget" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/CompleterTarget"></a>CompleterTarget:
                                    <span class="json-property-type">
                <span class="json-property-type">string</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>The completer implementation for which the command is intended. Typically,
                            this is set to <code>filetype_default</code>, but may also take any of the following
                            values:</p>
                            <ul>
                            <li><code>filetype_default</code>
                            Use the semantic completer associated with the filetype of the current
                            buffer. This is the default when a target is not supplied.</li>
                            <li><code>identifier</code>
                            Use the identifier completer.</li>
                            <li>Any filetype
                            Use the completer associated with the supplied filetype.</li>
                            </ul>
                            
                                </section>
                            
                    </div>
                </div>        
                <div id="definition-CompletionResponse" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/CompletionResponse"></a>CompletionResponse:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="completions">
                                                    <span class="json-property-name">completions:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>List of completion suggestions.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Candidate">Candidate</a>
                                                                            </span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                                <dt data-property-name="completion_start_column">
                                                    <span class="json-property-name">completion_start_column:</span>
                                                    
                                                    <span class="json-property-type">integer</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>1-based byte index of the column from which the completion should be
                                    applied. This is the column in which the words suggested in
                                    <code>completions</code> should be placed.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="errors">
                                                    <span class="json-property-name">errors:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>Any errors reported by the semantic completion engine.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                                            </span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-DebugInfoResponse" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/DebugInfoResponse"></a>DebugInfoResponse:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="name">
                                                    <span class="json-property-name">name:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>The completer name.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="servers">
                                                    <span class="json-property-name">servers:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>A list of servers used by the completer.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ServerData">ServerData</a>
                                                                            </span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                                <dt data-property-name="items">
                                                    <span class="json-property-name">items:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>Additional debugging information.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ItemData">ItemData</a>
                                                                            </span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-DiagnosticData" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/DiagnosticData"></a>DiagnosticData:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <ul>
                            <li><code>location</code>
                            The source location where the diagnostic applies. This is typically
                            (but not always) the start of <code>location_extent</code>.</li>
                            <li><code>location_extent</code>
                            The source range to which the diagnostic applies. This differs from
                            the <code>location</code> in that it refers to the whole range. Typically this is
                            used to underline, or otherwise render as &quot;error&quot; the source code
                            which caused the diagnostic.</li>
                            </ul>
                            
                                </section>
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="ranges">
                                                    <span class="json-property-name">ranges:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>List of ranges to which this diagnostic applies. These ranges
                                    typically identify the source locations which should be
                                    &quot;highlighted&quot; as incorrect.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Range">Range</a>
                                                                            </span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                                <dt data-property-name="location">
                                                    <span class="json-property-name">location:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Location">Location</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="location_extent">
                                                    <span class="json-property-name">location_extent:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Range">Range</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="text">
                                                    <span class="json-property-name">text:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>The diagnostic text (e.g. error message)</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="kind">
                                                    <span class="json-property-name">kind:</span>
                                                    
                                                    <span class="json-property-type">string</span>    <span class="json-property-enum" title="Possible values">, x &isin; {
                                                                    <span class="json-property-enum-item">WARNING</span>
                                                                ,
                                                                    <span class="json-property-enum-item">ERROR</span>
                                                                ,
                                                                    <span class="json-property-enum-item">INFORMATION</span>
                                                                ,
                                                                    <span class="json-property-enum-item">HINT</span>
                                                                
                                                            }
                                                            </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>The type of diagnostic being reported. Typically semantic engines will
                                    differentiate between warnings and fatal errors. Informational and
                                    hint messages should be treated as warnings where the client does not
                                    differentiate.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="fixit_available">
                                                    <span class="json-property-name">fixit_available:</span>
                                                    
                                                    <span class="json-property-type">boolean</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>If set to true, indicates that a quick fix action (FixIt) is
                                    available for this diagnostic. Typically this is used to indicate to
                                    the user that the <code>FixIt</code> subcommand is available.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-DiagnosticResponse" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/DiagnosticResponse"></a>DiagnosticResponse:
                                    <span class="json-property-type">
                <span class="json-property-type">object[]</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                            <section class="json-schema-array-items">
                                                
                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/DiagnosticData">DiagnosticData</a>
                                                </span>
                                                <span class="json-property-range" title="Value limits"></span>
                                                
                                                <div class="json-inner-schema">
                                                    
                                                </div>
                                            </section>    </div>
                </div>        
                <div id="definition-DiagnosticsMessage" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/DiagnosticsMessage"></a>DiagnosticsMessage:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>Diagnostics for a particular file. Note: diagnostics may be supplied for
                            any arbitrary file. The client is responsible for displaying the
                            diagnostics in an appropriate manner. The server supplies an empty set of
                            diagnostics to clear the diagnostics for a particular file.</p>
                            
                                </section>
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="filpath">
                                                    <span class="json-property-name">filpath:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FilePath">FilePath</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="diagnostics">
                                                    <span class="json-property-name">diagnostics:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/DiagnosticData">DiagnosticData</a>
                                                                            </span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-Exception" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/Exception"></a>Exception:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>JSON-encoded representation of a Python Exception object.</p>
                            
                                </section>
                            
                                        <section class="json-schema-additionalProperties">
                                            <span class="json-property-type">
                                        <span class="json-property-type">object</span>
                                        <span class="json-property-range" title="Value limits"></span>
                                        
                                        </span>
                                            
                                        </section>
                    </div>
                </div>        
                <div id="definition-ExceptionResponse" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/ExceptionResponse"></a>ExceptionResponse:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>The server raised an exception processing the request. This response is
                            often returned when the server is unable to perform the requested action,
                            not due to a bug or other error, but because it is not possible to do so.
                            For example, it is common for an exception response to be returned when
                            requesting &quot;GoToDefinition&quot; on an identifier for which the semantic,
                            engine is unable to find such a definition.</p>
                            
                                </section>
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="exception">
                                                    <span class="json-property-name">exception:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Exception">Exception</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="message">
                                                    <span class="json-property-name">message:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>The exception message. Typically a single line and suitable for
                                    display to a user.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="traceback">
                                                    <span class="json-property-name">traceback:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>A detailed report of the ycmd call stack at the point the exception
                                    was thrown. It is typically not required to display this to a user,
                                    as ycmd will print all exceptions to its log file (standard error).</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-ExtraConfData" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/ExtraConfData"></a>ExtraConfData:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>A dictionary passed to the <code>Settings( **kwargs )</code> function of the
                            <code>.ycm_extra_conf.py</code> file under the <code>client_data</code> key of <code>kwargs</code>. This
                            optional field should be used to give users a way to customize the
                            <code>.ycm_extra_conf.py</code> file with their own set of options.</p>
                            
                                </section>
                            
                    </div>
                </div>        
                <div id="definition-FileData" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/FileData"></a>FileData:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>Contents and details of a dirty buffer.</p>
                            
                                </section>
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="filetypes">
                                                    <span class="json-property-name">filetypes:</span>
                                                    
                                                    <span class="json-property-type">string[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">string</span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                                <dt data-property-name="contents">
                                                    <span class="json-property-name">contents:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>The entire contents of the buffer encoded as UTF-8.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-FileDataMap" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/FileDataMap"></a>FileDataMap:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>An object mapping whose keys are the absolute paths to the
                            files and whose values are data relating unsaved buffers.</p>
                            <p>An unsaved buffer is any file that is opened in the editor and has been
                            changed without saving the contents to disk.</p>
                            <p>The file referred to in the request <code>filepath</code> entry must <em>always</em> be
                            included. For most requests this is the user&#39;s current buffer, but may
                            be any buffer (e.g. in the case of closing a buffer which is not current).</p>
                            <p>When a file is closed in the editor, a <code>BufferUnload</code> event should be sent
                            and the file should not be included in further <code>FileDataMap</code> entries
                            until (or unless) it is opened and changed again.</p>
                            
                                </section>
                            
                                        <section class="json-schema-additionalProperties">
                                            <span class="json-property-type">
                                        <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FileData">FileData</a>
                                        </span>
                                        <span class="json-property-range" title="Value limits"></span>
                                        
                                        </span>
                                            
                                        </section>
                    </div>
                </div>        
                <div id="definition-FilePath" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/FilePath"></a>FilePath:
                                    <span class="json-property-type">
                <span class="json-property-type">string</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>Absolute path to the file in the filesystem. If the file does
                            not yet exist (for example, a new file), then the value should be an
                            arbitrary unique string.</p>
                            
                                </section>
                            
                    </div>
                </div>        
                <div id="definition-FixIt" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/FixIt"></a>FixIt:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="text">
                                                    <span class="json-property-name">text:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>The diagnostic text or a description of the modification to be made.
                                    This is the text displayed to the user when selecting from multiple
                                    available FixIts.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="location">
                                                    <span class="json-property-name">location:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Location">Location</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="resolve">
                                                    <span class="json-property-name">resolve:</span>
                                                    
                                                    <span class="json-property-type">boolean</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>Indicates whether the fixit requires additional processing.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="kind">
                                                    <span class="json-property-name">kind:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>FixIt kind is meant to suggest what sort of fixit this is. Clients
                                    are free to ignore this property or use it to decide whether to
                                    automatically apply the fixit. SUpported values are those of LSP.
                                    Search for <code>namespace CodeActionKind</code> in the following link
                                    <a href="https://microsoft.github.io/language-server-protocol/specifications/specification-3-15/#textDocument_codeAction">https://microsoft.github.io/language-server-protocol/specifications/specification-3-15/#textDocument_codeAction</a></p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="chunks">
                                                    <span class="json-property-name">chunks:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>A list of ranges and replacements which must be applied to source
                                    files. <em>NOTE</em>: The source ranges may span arbitrary files and the
                                    sequence of <code>chunks</code> is not defined.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">object</span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                                        <section class="json-schema-properties">
                                                                                            <dl>
                                                                                                    <dt data-property-name="replacement_text">
                                                                                                        <span class="json-property-name">replacement_text:</span>
                                                                                                        
                                                                                                        <span class="json-property-type">string</span>
                                                                                                        <span class="json-property-range" title="Value limits"></span>
                                                                                                        
                                                                                                            <span class="json-property-required"></span>
                                                                                                    </dt>
                                                                                                    <dd>
                                                                                                        <p>The text with which to replace the range identified by <code>range</code>.</p>
                                                                                        
                                                                                                        <div class="json-inner-schema">
                                                                                                            
                                                                                                        </div>
                                                                                                    </dd>
                                                                                                    <dt data-property-name="range">
                                                                                                        <span class="json-property-name">range:</span>
                                                                                                        
                                                                                                        <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Range">Range</a>
                                                                                                        </span>
                                                                                                        <span class="json-property-range" title="Value limits"></span>
                                                                                                        
                                                                                                            <span class="json-property-required"></span>
                                                                                                    </dt>
                                                                                                    <dd>
                                                                                                        
                                                                                                        <div class="json-inner-schema">
                                                                                                            
                                                                                                        </div>
                                                                                                    </dd>
                                                                                            </dl>
                                                                                        </section>
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-ItemData" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/ItemData"></a>ItemData:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="key">
                                                    <span class="json-property-name">key:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="value">
                                                    <span class="json-property-name">value:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-LineNumber" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/LineNumber"></a>LineNumber:
                                    <span class="json-property-type">
                <span class="json-property-type">integer</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>1-based line number.</p>
                            
                                </section>
                            
                    </div>
                </div>        
                <div id="definition-Location" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/Location"></a>Location:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>A contiguous range of bytes in a source buffer starting at <code>start</code> and
                            finishing at <code>end</code>. The range is (effectively) exclusive. That is if start
                            points to (10,1) and end points to (10,3), then the length of the range
                            is 2 characters.</p>
                            
                                </section>
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="line_num">
                                                    <span class="json-property-name">line_num:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/LineNumber">LineNumber</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="column_num">
                                                    <span class="json-property-name">column_num:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ColumnNumber">ColumnNumber</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="filepath">
                                                    <span class="json-property-name">filepath:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FilePath">FilePath</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-Message" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/Message"></a>Message:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>An object containing a single asynchronous message.
                            It is either a <code>SimpleDisplayMessage</code> or a <code>DiagnosticsMessage</code></p>
                            
                                </section>
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="message">
                                                    <span class="json-property-name">message:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/SimpleDisplayMessage">SimpleDisplayMessage</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>If present, this object is a <code>SimpleDisplayMessage</code></p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="diagnostics">
                                                    <span class="json-property-name">diagnostics:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/DiagnosticsMessage">DiagnosticsMessage</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>If present, this object is a <code>DiagnosticsMessage</code></p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-MessageList" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/MessageList"></a>MessageList:
                                    <span class="json-property-type">
                <span class="json-property-type">object[]</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>A list of messages in the sequence they should be handled.</p>
                            <p>The type of message in each item is determined by the property name:</p>
                            <ul>
                            <li>An object with a property <code>message</code> is a <em>simple display message</em> where
                            the property value is the message.</li>
                            <li>An object with a property <code>diagnostics</code> contains diagnostics for a
                            project file. The value of the property is described below.</li>
                            </ul>
                            
                                </section>
                            
                                            <section class="json-schema-array-items">
                                                
                                                <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Message">Message</a>
                                                </span>
                                                <span class="json-property-range" title="Value limits"></span>
                                                
                                                <div class="json-inner-schema">
                                                    
                                                </div>
                                            </section>    </div>
                </div>        
                <div id="definition-MessagePollResponse" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/MessagePollResponse"></a>MessagePollResponse:
                                    <span class="json-property-type">
                <span class="json-property-type">boolean</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>When <code>true</code> is returned, the request timed out (meaning no
                            messages were returned in the poll period). Clients should
                            send another <code>receive_messages</code> request immediately.</p>
                            <p>When <code>false</code> is returned, the server determined that message
                            polling should abort for the current file type context. Clients
                            should not re-send this request until the filetype being edited
                            changes or the server is restarted.</p>
                            
                                </section>
                            
                    </div>
                </div>        
                <div id="definition-Range" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/Range"></a>Range:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>A contiguous range of bytes in a source buffer.</p>
                            
                                </section>
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="start">
                                                    <span class="json-property-name">start:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Location">Location</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="end">
                                                    <span class="json-property-name">end:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Location">Location</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-ResolveCompletionResponse" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/ResolveCompletionResponse"></a>ResolveCompletionResponse:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="completion">
                                                    <span class="json-property-name">completion:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/Candidate">Candidate</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="errors">
                                                    <span class="json-property-name">errors:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>Any errors reported by the semantic completion engine.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
                                                                            </span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-ServerData" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/ServerData"></a>ServerData:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="name">
                                                    <span class="json-property-name">name:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>The server name.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="is_running">
                                                    <span class="json-property-name">is_running:</span>
                                                    
                                                    <span class="json-property-type">boolean</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p><code>true</code> if the server is running, <code>false</code> otherwise.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="executable">
                                                    <span class="json-property-name">executable:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>The executable path used to start the server.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="address">
                                                    <span class="json-property-name">address:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>The address on which the server is listening. <code>null</code> if not
                                    applicable.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="port">
                                                    <span class="json-property-name">port:</span>
                                                    
                                                    <span class="json-property-type">integer</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>The port on which the server is listening. <code>null</code> if not applicable.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="pid">
                                                    <span class="json-property-name">pid:</span>
                                                    
                                                    <span class="json-property-type">integer</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>The process identifier of the server. <code>null</code> if the server is not
                                    running.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="logfiles">
                                                    <span class="json-property-name">logfiles:</span>
                                                    
                                                    <span class="json-property-type">string[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>A list of logging files used by the server.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">string</span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                    <section class="json-schema-description">
                                                                                        <p>A logging file path.</p>
                                                                                
                                                                                    </section>
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                                <dt data-property-name="extras">
                                                    <span class="json-property-name">extras:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ItemData">ItemData</a>
                                                                            </span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-SimpleDisplayMessage" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/SimpleDisplayMessage"></a>SimpleDisplayMessage:
                                    <span class="json-property-type">
                <span class="json-property-type">string</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>A message for display to the user. Note: the message should be displayed
                            discreetly (such as in a status bar) and should not block the user or
                            interrupt them.</p>
                            
                                </section>
                            
                    </div>
                </div>        
                <div id="definition-SimpleRequest" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/SimpleRequest"></a>SimpleRequest:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="line_num">
                                                    <span class="json-property-name">line_num:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/LineNumber">LineNumber</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="column_num">
                                                    <span class="json-property-name">column_num:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ColumnNumber">ColumnNumber</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="filepath">
                                                    <span class="json-property-name">filepath:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FilePath">FilePath</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="file_data">
                                                    <span class="json-property-name">file_data:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FileDataMap">FileDataMap</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="completer_target">
                                                    <span class="json-property-name">completer_target:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/CompleterTarget">CompleterTarget</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="working_dir">
                                                    <span class="json-property-name">working_dir:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/WorkingDirectory">WorkingDirectory</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="extra_conf_data">
                                                    <span class="json-property-name">extra_conf_data:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ExtraConfData">ExtraConfData</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-SubcommandResponse" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/SubcommandResponse"></a>SubcommandResponse:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="fixits">
                                                    <span class="json-property-name">fixits:</span>
                                                    
                                                    <span class="json-property-type">object[]</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>If present, this is a <em>FixIt</em> or <em>Refactor</em> response and the
                                    value of this property is a list of potential changes to
                                    buffers to apply the quick fix or refactoring operation.</p>
                                    <p>An empty <code>fixits</code> list means that no FixIt or refactoring
                                    was available. If multiple entries are supplied, the user is
                                    prompted to select which one to apply.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                                        <section class="json-schema-array-items">
                                                                            
                                                                            <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/FixIt">FixIt</a>
                                                                            </span>
                                                                            <span class="json-property-range" title="Value limits"></span>
                                                                            
                                                                            <div class="json-inner-schema">
                                                                                
                                                                            </div>
                                                                        </section>                </div>
                                                </dd>
                                                <dt data-property-name="message">
                                                    <span class="json-property-name">message:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>If present, this is a <em>simple display message</em> and the value
                                    of this property is the message to display.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="detailed_info">
                                                    <span class="json-property-name">detailed_info:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>If present, this is a <em>detailed information</em> response and
                                    the value of this property is the multi-line information
                                    to display as unformatted plain text.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="filepath">
                                                    <span class="json-property-name">filepath:</span>
                                                    
                                                    <span class="json-property-type">string</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>If present, this is a single <em>GoTo response</em> and this value
                                    contains the absolute path of the buffer containing the
                                    target location (identified in <code>line_num</code> and <code>column_num</code>).</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="line_num">
                                                    <span class="json-property-name">line_num:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/LineNumber">LineNumber</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="column_num">
                                                    <span class="json-property-name">column_num:</span>
                                                    
                                                    <span class="json-property-type">    <a class="json-schema-ref" href="#/definitions/ColumnNumber">ColumnNumber</a>
                                                    </span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                                <dt data-property-name="extra_data">
                                                    <span class="json-property-name">extra_data:</span>
                                                    
                                                    <span class="json-property-type">object</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                </dt>
                                                <dd>
                                                    <p>Additional data specific to the response type. For GoTo requests,
                                    this may include &quot;kind&quot; and &quot;name&quot; to specify additional data about
                                    the GoTo target when doing a symbol search, such as GoToSymbol
                                    or GoToDocumentOutline. If supplied, &quot;kind&quot; is a LSP symbol kind.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-UnresolvedFixIt" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/UnresolvedFixIt"></a>UnresolvedFixIt:
                                    <span class="json-property-type">
                <span class="json-property-type">object</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                            
                                    <section class="json-schema-properties">
                                        <dl>
                                                <dt data-property-name="resolve">
                                                    <span class="json-property-name">resolve:</span>
                                                    
                                                    <span class="json-property-type">boolean</span>
                                                    <span class="json-property-range" title="Value limits"></span>
                                                    
                                                        <span class="json-property-required"></span>
                                                </dt>
                                                <dd>
                                                    <p>Indicates whether the fixit requires additional processing.</p>
                                    
                                                    <div class="json-inner-schema">
                                                        
                                                    </div>
                                                </dd>
                                        </dl>
                                    </section>
                    </div>
                </div>        
                <div id="definition-WorkingDirectory" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/WorkingDirectory"></a>WorkingDirectory:
                                    <span class="json-property-type">
                <span class="json-property-type">string</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>Absolute path to the filesystem working directory of the client. This is
                            used by completer engines to determine things like the project root
                            for the file being modified, amongst other things.</p>
                            
                                </section>
                            
                    </div>
                </div>        
                <div id="definition-YesNo" class="panel panel-definition">
                        <div class="panel-heading">
                                <h3 class="panel-title"><a name="/definitions/YesNo"></a>YesNo:
                                    <span class="json-property-type">
                <span class="json-property-type">boolean</span>
                <span class="json-property-range" title="Value limits"></span>
                
                </span>
                                </h3>
                        </div>
                    <div class="panel-body">
                                <section class="json-schema-description">
                                    <p>Result of the query: <code>true</code> if yes, <code>false</code> otherwise.</p>
                            
                                </section>
                            
                    </div>
                </div>
</div>
<script src="bundle.js" type="application/javascript"></script>
</body>
</html>
